/*
	Copyright 2007-2010 Petr Ohlidal

	This file is a part of GrobMaker

	GrobMaker is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	GrobMaker is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with GrobMaker.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef GROBMAKER_HELP
#define GROBMAKER_HELP

/**
 * @file help.hpp
 * @brief Stores the program's console help text.
 *
 * Defines a global const string which holds the help text.
 */

#include <string>

namespace GrobMaker{

static const std::string HELP(\
"Program arguments\
\
-a   --no-visual-angles    (integer 1-360, default detected):\
                           Number of visual angles this grob has.\
-n   --grob-name           (string, default = source dir name):\
                           Name of the grob.\
-S   --sprites-dir         (string): Directory with sprites.\
-s   --single-sprite       (string): Path to sprite image.\
-w   --sprite-width        (integer, default 0):\
                           Target width of the sprite in pixels.\
                           If 0 is given, the width will be calculated from\
                           aspect ratio.\
-h,  --sprite-height       (integer, default 0):\
                           Target height of the sprite in pixels.\
                           If 0 is given, the height will be calculated from aspect ratio.\
                           Note: This scale applies to source image (before cutting off edges).\
                           The final sprite size depends on the graphic.\
-P   --add-peg             (string): Directory with peg source images.\
-p   --add-single-peg      (string): A path to peg source image.\
-m   --set-peg-name        (string): Names the last added peg. If no pegs were\
                           added at all, all entered names are placed into\
                           fifo-stack and assigned to upcoming pegs.\
                           Subsequent use of the arg overruns the stacked name\
                           for last added grob.\
-i   --omit-pegs           (no arg): Don't search for or process pegs.\
-H   --shades-dir          (string): Directory with shade images.\
-h   --single-shade        (string): Path to shade image.\
-I   --omit-shades         (no value): If given, shades will not be parsed or saved\
                           and ImageAreas will supplement them.\
-t   --single-pivot        (string): Path to pivot source image.\
-T   --pivots-dir          (string): Directory with pivot images.\
-o   --output-dir          (string, default 'grob'): Root directory for output.\
-r   --source-dir          (string, default '.'): Root directory for input.\
-c   --script-path         (string, default 'grob.lua'): Path to save grobfile.\
-e   --parse-shadow        (no arg)\
-l   --shadow-alpha        (float, default 0.55):\
                           Specifies the minimum transparency used when creating shadows.\
                           If given, each sprite will be processed as shadow sprite.\
                           If 0 is entered, the default value is used.\
-D   --shadows-dir         (string): Enables shadow parsing and sets shadow-sprites dir.\
-d   --single-shadow       (string): Enables shadow parsing and sets single shadow-sprite.\
-j   --just-search         Don't parse images, just print image locations.\
-L   --log (string)        Print verbose log into specified file.\
-v   --verbose             Enable verbose console output.\
     --version             (no arg): Print info and exit.\
     --help                (no arg): Print help and exit.\
     --out-dir-exists      (string, default 'new-name')\
                           Sets the action to perform if the grobDir already exists.\
                           Options are:\
                           'new-name': Creates a dir under a new name (adds a number)\
                           'end': Exits the program\
                           'ask-action': Ask user interactively to specify action.\
                           'ask-new-name': Ask the user interactively for new grobDir name\
                           'continue': Use the entered dir anyway (overwrites existing files)\
-f   --format              (string, default 'png'): Specify format and extension\
                           of outputted images.");

} // namespace GrobMaker

#endif //#ifndef GROBMAKER_HELP
